Skip to main content
Version: 24.05

postRequestForQuotation​

postRequestForQuotation

Path Parameters
  • api-endpoint uuid required

    The API endpoint to send a request for quotation to a manufacturer.

Request Body
  • filter string required

    The filter to use.

Responses

The request was successful.

Schema
  • rfqIdentification object

    all properties necessary for identification of the request for quotation

  • rfqSource string

    RFQ-Identification: digital address of the sender (e.g.token, IP address, link, user account)

  • rfqId string

    RFQ-Identification: internal identifier in user account

  • rfqName string

    RFQ-Identification: name for the request for user account management (usually name of the product to be manufactured)

  • rfqDateTime string

    Possible values: Value must match regular expression -?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T(([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\.[0-9]+)?|(24:00:00(\.0+)?))(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?

    RFQ-Identification: date and time of the request in user account

  • rfqVersion string

    RFQ-Identification: version of this request in case there were any changes

  • rfqConfiguration object

    all information to configure a request for quotation

  • cadFile object

    RFQ-Configuration: CAD file as geometry definition, e.g. step file

  • fileType string

    RFQ-Configuration: file format

  • filePath string

    path or address to the file

  • fileName string

    name of the file

  • fileObject object

    the file object itself, in case this could be sent via the API

  • parts object

    RFQ-Configuration: list of parts contained in the CAD file

  • partId string

    RFQ-PartConfiguration: identifier of the part from CAD File

  • partName string

    RFQ-PartConfiguration: name of the part in CAD file. In case the CAD file has only one part, this could also be the file name.

  • manufacturingDomain string

    RFQ-PartConfiguration: domain of required process (e.g. subtractive manufacturing, additive manufacturing, assembly)

  • generalTolerance string

    RFQ-PartConfiguration: selection of defined tolerance classes

  • additionalRequirements string

    RFQ-PartConfiguration: specific requirements e.g. to guarantee quality, like premium quality check or standard quality check or test part required (makes only sense for batch)

  • material object

    RFQ-PartConfiguration: material definition with further information

  • materialProperties object

    material definition with additional detail properties with name, value and value type, like name= density, value=2.7, type=g/m3 or name= chemical term, value=AlMgMn, type=periodic table

  • value string

    value to detail the part material item

  • valueType string

    value type to specify the value of the property

  • propertyName string

    name of the property

  • materialFamily string

    definition of material family for preselection

  • partQuantity object

    RFQ-PartConfiguration: Quantity of which the part item is assembled into the parent item (within the CAD File). In general it is '1' for serialized parts.

  • quantityNumber number

    The number of objects related to the measurement unit

  • measurementUnit string

    Possible values: Value must match regular expression [a-zA-Z]*:[a-zA-Z]+

    Unit of Measurement for the quantity of serialized objects

  • billOfProcess object

    RFQ-PartConfiguration: list of process steps for part to be manufactured

  • process object[]

    List that contains all manufacturing steps of a product, whereat each manufacturing step refers to exactly one capability. This list contains all process steps that are required to manufacture the product, specified with the bill of process

  • processStepIdentifier string[]

    Unique identifier for a concrete process step

  • inputParameters object[]

    Optional list of parameters that are required to execute the corresponding process step

  • name string

    Name of the parameter

  • value string

    Value of the parameter

  • semanticReference string[]

    Reference to a semantic namespace in which the type of the parameter is defined

  • parameterKey string

    Possible values: [HasValue, HasNoValue, HasValueRange, HasTolerances]

    Enumeration that is used to distinguish whether the parameter has no value, has a value, has a value range or has a value with tolerances

  • valueRangeList object[]

    List with value ranges for a parameter

  • lowerValue string

    Lower border of a value range item

  • upperValue string

    Upper border for a value range item

  • name string

    Name of the parameter

  • tolerances object[]

    Tolerances for a parameter

  • lowerLimit string

    The lower direct limit of the tolerance

  • upperLimit string

    Upper direct limit of the tolerance

  • name string

    Name of the parameter

  • outputParameters object[]

    Optional list of parameters that are returned from the process step and can be used as inputParameters for subsequent steps

  • name string

    Name of the parameter

  • value string

    Value of the parameter

  • semanticReference string[]

    Reference to a semantic namespace in which the type of the parameter is defined

  • parameterKey string

    Possible values: [HasValue, HasNoValue, HasValueRange, HasTolerances]

    Enumeration that is used to distinguish whether the parameter has no value, has a value, has a value range or has a value with tolerances

  • valueRangeList object[]

    List with value ranges for a parameter

  • lowerValue string

    Lower border of a value range item

  • upperValue string

    Upper border for a value range item

  • name string

    Name of the parameter

  • tolerances object[]

    Tolerances for a parameter

  • lowerLimit string

    The lower direct limit of the tolerance

  • upperLimit string

    Upper direct limit of the tolerance

  • name string

    Name of the parameter

  • precedenceRelation object[]

    List of alternative process steps from which the manufacturer has to select exactly one step to be executed. In case of no alternative process step, the list features only one element. In case of the last element, the property is not used, since the process step has no successor

  • precedenceElements object[]

    List process steps that must be executed in parallel

  • successor string[]

    List of subsequent process step which can be executed in any order

  • childProcessSteps string[]

    List of child processes that need to be executed to complete the parent process step. It enables the expression of hierarchies between capabilities, e.g. a transport capability needs to execute at least a pick, a move and a place capability

  • processStepType string

    Possible values: [IsFirstElement, IsLastElement, IsProcessElement, IsSubprocessElement]

    Distinguishes process steps based on whether there are the first or last process step to be executed, or if they are a subprocess step, which subdivides a higher-level process step into smaller process steps

  • capabilityId string

    Locally unique identifier for a capability.

  • productVersion string

    Version of the product whose manufacturing steps are specified with the bill of process. It can for example specify a concrete variant of a product

  • productName string

    Name of the product whose production steps are specified within the bill of process

  • billOfProcessIdentification string

    Unique identifier for a bill of process that can be used to reference instances of the bill of process

  • version string

    Possible values: Value must match regular expression ^(0|[1-9][0-9]*).(0|[1-9][0-9]*).(0|[1-9][0-9]*)(-(0|[1-9A-Za-z-][0-9A-Za-z-]*)(.[0-9A-Za-z-]+)*)?([0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?$

    The unique identifier of the aspect model defining the structure and the semantics of the message's header. The version number should reflect the versioning schema of aspect models in Catena-X.

  • firstDeliveryDate date

    RFQ-Configuration: Date of desired, first, but not must delivery

  • lastDeliveryDate date

    RFQ-Configuration: date of required and last acceptable delivery

  • additionalComments string

    RFQ-Configuration: placeholder for any kind of additional comments

  • additionalFiles object

    RFQ-Configuration: in case there are additional documents or files to share (like e.g. technical drawings)

  • fileType string

    RFQ-Configuration: file format

  • filePath string

    path or address to the file

  • fileName string

    name of the file

  • fileObject object

    the file object itself, in case this could be sent via the API

  • orderQuantity object

    RFQ-Configuration: quantity at all, valid for complete order (usually number of products to be ordered)

  • quantityNumber number

    The number of objects related to the measurement unit

  • measurementUnit string

    Possible values: Value must match regular expression [a-zA-Z]*:[a-zA-Z]+

    Unit of Measurement for the quantity of serialized objects

  • rfqSender object

    all data about sender of request for quotation, important for offer and delivery

  • senderName string

    RFQ-Sender: name of the sender

  • senderAdress string

    RFQ-Sender: BPDM/ or fill in by the customer, address of sender

  • senderCompanyName string

    RFQ-Sender: BPDM/ or fill in by the customer, company name of sender

  • senderEMail string

    RFQ-Sender: BPDM/ or fill in by the customer, e-mail address of sender

  • senderPhoneNumber string

    RFQ-Sender: BPDM/ or fill in by the customer, phone number of sender

  • senderAccountAddress string

    RFQ-Sender: BPDM/ or fill in by the customer, address of sender for account

  • senderDeliveryAddress string

    RFQ-Sender: BPDM/ or fill in by the customer, address of sender for delivery

  • deliveryRequirements string

    RFQ-Sender: filled by customer, any kind of delivery requirements

  • cxHeader object

    header information by Catena-X

  • messageId string

    Possible values: Value must match regular expression (^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$)|(^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$)

    Unique ID identifying the message. The purpose of the ID is to uniquely identify a single message, therefore it MUST not be reused.

  • context string

    Information about the context the message should be considered in. The value MUST consist of two parts: an identifier of the context (e.g. business domain, etc.) followed by a version number. Both the identifier and the version number MUST correspond to the content of the message. If the content of a message is described by an aspect model available in the Catena-X Semantic Hub, then the unique identifier of this semantic model (e.g. urn:samm:io.catenax.:1.x.x) MUST be used as a value of the context field. This is considered the default case. In all other cases the value of the context field MUST follow the pattern --:<[major] version> (e.g. TRACE-QM-Alert:1.x.x). Versioning only refers to major versions in both default and fallback cases. Note: The version of the message's header is specified in the version field.

  • sentDateTime string

    Possible values: Value must match regular expression -?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T(([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\.[0-9]+)?|(24:00:00(\.0+)?))(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?

    Time zone aware timestamp holding the date and the time the message was sent by the sending party. The value MUST be formatted according to the ISO 8601 standard

  • senderBpn string

    Possible values: Value must match regular expression ^BPNL[a-zA-Z0-9]{12}$

    The Business Partner Number of the sending party. The value MUST be a valid BPN. BPNA and BPNS are not allowed. Applicable constraints are defined in the corresponding standard

  • receiverBpn string

    Possible values: Value must match regular expression ^BPNL[a-zA-Z0-9]{12}$

    The Business Partner Number of the receiving party. The value MUST be a valid BPN. BPNA and BPNS are not allowed. Applicable constraints are defined in the corresponding standard.

  • expectedResponseBy string

    Possible values: Value must match regular expression -?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T(([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\.[0-9]+)?|(24:00:00(\.0+)?))(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?

    Time zone aware timestamp holding the date and time by which the sending party expects a certain type of response from the receiving party. The meaning and interpretation of the fields's value are context-bound and MUST therefore be defined by any business domain or platform capability making use of it. The value MUST be formatted according to the ISO 8601 standard

  • relatedMessageId string

    Possible values: Value must match regular expression (^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$)|(^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$)

    Unique ID identifying a message somehow related to the current one

  • version string

    Possible values: Value must match regular expression ^(0|[1-9][0-9]*).(0|[1-9][0-9]*).(0|[1-9][0-9]*)(-(0|[1-9A-Za-z-][0-9A-Za-z-]*)(.[0-9A-Za-z-]+)*)?([0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?$

    The unique identifier of the aspect model defining the structure and the semantics of the message's header. The version number should reflect the versioning schema of aspect models in Catena-X.

Loading...